Skip to main content

Pre-Requisites

Connection Requirements

Flat File Requirements

  • The flat files you import must use the column headers specified in the Flat File Template.

Connecting to Flat Data Sources

Each Flat file is a table. The naming for User Account and Permissions are as follows -

  • User Account CSV - usr.csv
  • Permissions CSV - permissions.csv
  • User Permission Map CSV - usr_permission_map.csv

Here are the connection string examples for Local Path, FTP/FTPS, and SFTP data sources:

Local Path - Directory Path (One table per file):

tip

For self-hosted connector the flat file needs to be at the same VM/machine.

Example:

jdbc:csv:URI=file:///home/sath/Desktop

FTP or FTPS - Directory Path (One table per file):

tip

For cloud connector following information would be needed:

  • User
  • password
  • URI

The connector would then auto convert this into the connection string (Example given below)

Example:

jdbc:csv:AuthScheme=Basic;User=user1;Password=password1;ConnectionType=FTP;URI=ftp://abc.xyz.com/sath;OAuthGrantType=PASSWORD;AggregateFiles=false

File Structure

Each row in the file corresponds to a single account, except for fields with multi-valued attributes. Each column contains data related to the account and follows a specific, predefined sequence as outlined in the Account Schema. The file must be sorted by the ID attribute to properly manage multi-valued attributes.

The first row contains the file headers and will not be processed.

Example:

idnamefirstNamelastName...The header row will be ignored.
1jsmithJeromeSmith...This is the first account
2ssmithSamanthaSmith...This is the second account

Managing Multi-Valued Attributes

Some attributes, such as groups, can contain multiple values and are stored as lists. To represent this, each value should be placed on a separate row for that attribute, with other field values repeated as necessary.

Example:

idname...groups...
1jsmith...Admins...
2jsmith...Employee...
3ssmith...Employee...
First instance of the account
Continuation of the first account with a new group value; other fields remain the same
New account

Note: The header row will be ignored during processing.